Guide

Migrating protocols from v2 to v3

Although we introduced a major version change, migrating from v2 to v3 should be straightforward.

The main differences are the introduction of the new Set LiveDesign Connection Details as described in the changelog and the use of IDs instead of names (also described in the changelog)

  1. The very first thing to do is to add the Set LiveDesign Connection Details component at the begining of your protocol.

  2. Upgrade each component of the Discngine LiveDesign-Pipeline Pilot Connector collection by right-clicking on them and selecting Replace with Latest Version.

  3. Update the parameters of those components following the indications below.

v2 Parameters v3 Parameters Notes on changes
Live Report ID LiveReport ID breaking - Space removed between "Live" and "Report"
v2 Parameters v3 Parameters Notes on changes
Live Report ID LiveReport ID breaking - Space removed between "Live" and "Report"
v2 Parameters v3 Parameters Notes on changes
Live Report ID LiveReport ID breaking - Space removed between "Live" and "Report"
Group Group Details Renamed
Group > Name Group Details > Name Unchanged
Group > Columns Group Details > Column IDs Renamed
Group > Position Group Details > Position Unchanged
Group > Freeze Columns Group Details > Freeze Columns Unchanged
v2 Parameters v3 Parameters Notes on changes
Live Report ID LiveReport ID breaking - Space removed between "Live" and "Report"
Columns Properties Renamed
Published Published Unchanged
v2 Parameters v3 Parameters Notes on changes
Live Report ID LiveReport ID breaking - Space removed between "Live" and "Report"
Published Published Unchanged
Definition Mode Definition Mode Unchanged
Columns Columns Unchanged
Columns > Column [i] Columns > Column [i] Unchanged
Columns > Column [i] > Name Columns > Column [i] > Column Name Renamed
Columns > Column [i] > Model Columns > Column [i] > Property Renamed
Columns > Column [i] > Endpoint Columns > Column [i] > Endpoint Unchanged
Columns > Column [i] > Unit Columns > Column [i] > Unit Unchanged
JSON JSON Unchanged
v2 Parameters v3 Parameters Notes on changes
Live Report ID LiveReport ID breaking - Space removed between "Live" and "Report"
Other parameters unchanged
v2 Parameters v3 Parameters Notes on changes
Live Report ID LiveReport ID breaking - Space removed between "Live" and "Report"
IDs Row IDs Renamed
v2 Parameters v3 Parameters Notes on changes
Live Report ID LiveReport ID breaking - Space removed between "Live" and "Report"
Other parameters unchanged
v2 Parameters v3 Parameters Notes on changes
Live Report Name LiveReport Name breaking - Space removed between "Live" and "Report"
Template Name Template ID breaking
Default Rationale Default Rationale Unchanged
Is Template Is Template Unchanged
Project Name Project ID breaking (default project is 0 - Global)
Folder Name Folder ID breaking
Nested Folder Name - breaking - Removed since it is covered by Folder ID. Indicate the ID of the nested folder if needed.
v2 Parameters v3 Parameters Notes on changes
Live Report Name LiveReport Name breaking - Space removed between "Live" and "Report"
Default Rationale Default Rationale Unchanged
Is Template Is Template Unchanged
Published Published Unchanged
Live Design Project Name Project ID breaking (default project is 0 - Global)
Folder Name Folder ID breaking
Nested Folder Name - breaking - Removed since it is covered by Folder ID. Indicate the ID of the nested folder if needed.
v2 Parameters v3 Parameters Notes on changes
Folder Name Folder Name Unchanged
Project Name Project ID breaking (default project is 0 - Global)
v2 Parameters v3 Parameters Notes on changes
Nested Folder Name Nested Folder Name Unchanged
Folder Name Location > Parent Folder ID breaking
Project Name Location > Project ID breaking
v2 Parameters v3 Parameters Notes on changes
Live Design Project Id Project ID breaking